<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>

	<title>Crunchy :: Home</title>

	<link rel="stylesheet" href="/css/crunchy_docs.css" type="text/css" charset="utf-8"/>
</head>

<body>

<div id="container">
<div id="titlebar">
<a href="/index.html">
<img src="/images/crunchy-python-powered.png" alt="Crunchy home" title="Crunchy home"/>
</a>
<div id="main_title">Welcome To Crunchy</div>
</div>

<div id="crunchy_sidebar">
<div class="boxcap captop"></div>
    <ul class="categories">
    <li class="category">
        <span class="heading open">Basic Crunchy Tutorial</span>
        <ul>
        <li><a href="/docs/basic_tutorial/introduction.html">Introduction</a></li>
        <li><a href="/docs/basic_tutorial/interpreter.html">Interpreter</a></li>
        <li><a href="/docs/basic_tutorial/editor.html">Editor</a></li>
        <li><a href="/docs/basic_tutorial/doctest.html">DocTest</a></li>
        <li><a href="/docs/basic_tutorial/unittest.html">UnitTest</a></li>
        <li><a href="/docs/basic_tutorial/images.html">Images and dhtml</a></li>
        <li><a href="/docs/basic_tutorial/external.html">External applications</a></li>
        <li><a href="/docs/basic_tutorial/preferences.html">User preferences</a></li>
        <li><a href="/docs/basic_tutorial/browsing.html">Browsing</a></li>
        </ul>
    </li>
    <li class="category">
        <span class="heading">Advanced Topics</span>
        <ul>
        <li><a href="/docs/advanced_tutorial/more_interpreters.html">More Interpreters</a></li>
        <li><a href="/docs/advanced_tutorial/pygment_style.html">Styling with Pygments</a></li>
        <li><a href="/docs/advanced_tutorial/canvas.html">Graphics</a></li>
        <li><a href="/docs/advanced_tutorial/named_colours.html">Colourful names</a></li>
        <li><a href="/docs/advanced_tutorial/user_markup.html">User defined markup</a></li>
        <li><a href="/docs/advanced_tutorial/language_negociation.html">Language negociation</a></li>
        <li><a href="/docs/advanced_tutorial/analyzer.html">Code Quality</a></li>
        <li><a href="/docs/advanced_tutorial/rst_directives.txt">reStructuredText</a></li>
        </ul>
    </li>
    <li class="category">
        <span class="heading">Writing Tutorials</span>
        <ul>
        <li><a href="/docs/writing/introduction.html">Writing tutorials</a></li>
        <li><a href="/docs/writing/interactive.html">Interactive Elements</a></li>
        <li><a href="/docs/writing/templates.html">Using Templates</a></li>
        <li><a href="/docs/writing/username.html">User's Name</a></li>
        <li><a href="/docs/writing/configuration2.html">Enabling Preferences Settings</a></li>
        <li><a href="/docs/writing/cluetip.html">Popup Helpers</a></li>
        <li><a href="/docs/writing/misc_vlam.html">Miscellaneous VLAM</a></li>
        </ul>
    </li>
    <li class="category">
        <span class="heading">About Crunchy</span>
        <ul>
        <li><a href="/docs/about/history.html">In the beginning...</a></li>
        <li><a href="/docs/about/contributors.html">Contributors</a></li>
        <li><a href="/docs/about/software.html">Software used by Crunchy</a></li>
        <li><a href="/docs/about/magic.html">How does Crunchy perform its magic?</a></li>
        <li><a href="/docs/about/faq.html">FAQ, bugs, etc.</a></li>
        </ul>
    </li>
    <li class="category">
        <span class="heading">For Developers</span>
        <ul>
        <li>Writing plugins: to do.</li>
        <li><a href="/docs/tests/tests_index.html">Tests</a></li>
        <li><a href="/functional_tests/index.html">Old tests - to be reorganized</a></li>
        </ul>
    </li>
    <li class="category">
        <span class="heading">Experimental Features</span>
        <ul>
        <li><a href="/docs/experimental/about_exp.html">About This Section</a></li>
        <li><a href="/docs/experimental/pygment_style_experiment.html">Creating a new Pygments style</a></li>
        <li><a href="/docs/experimental/single_step.html">pdb interface test</a></li>
        <li><a href="/docs/experimental/exam_mode.html">Exam mode</a></li>
        <li><a href="/docs/experimental/turtle.html">Turtle</a></li>
        <li><a href="/docs/experimental/colorpicker.html">Colour Picker</a></li>
        <li><a href="/docs/experimental/getsource.html">getsource plugin</a></li>
        <li><a href="/docs/experimental/rst_edit.html">rst_edit widget</a></li>
        </ul>
    </li>
    </ul>
<div class="boxcap"></div>
</div>
<div id="content">

<h2>Hello <span title="username">user</span>!
Welcome to version
<b><span title="version">automatically inserted from version.py</span></b> of Crunchy!</h2>
<p>New: the <a href="/docs/experimental/rst_edit.html">rst_edit widget</a>
can also be found in the experimental section of the menu
</p>

<h3>What is needed to run Crunchy?</h3>
<p>Since you are reading this, chances are that you are already using Crunchy.
If that is not the case, in addition to Crunchy you will also need:
</p>
<ul>
<li><a href="www.python.org" title="external_link">Python</a>.
I do mean Guido van Rossum's Python, not Monty Python nor a real life snake.
Chances are it is already installed on your computer; but you do need a version
no older than version 2.4. Crunchy has been tested with Python 2.4, 2.5, 2.6, and 3.1 !!</li>
<li>Alternatively, you may try <a href="www.jython.org" title="external_link">Jython</a>.
Crunchy has been tested successfully with Jython 2.5.0.</li>
<li><a href="firefox.com" title="external_link">Firefox</a>.
Crunchy may work (at least partially) with some other browsers,
but it is currently only tested with Firefox. </li>
</ul>

<h3>Warning: mixed behaviour when working with unicode</h3>
<p>Internally, Crunchy works with utf-8 encoding.  This leads to a slight
change when using Python 2.x with Crunchy for unicode strings.
For example, when working from the terminal, on a Mac OS, the following happens:
</p>
<pre title="pycon">
&gt;&gt;&gt; print 'André'
André
&gt;&gt;&gt; 'André'
'Andr\xc3\xa9'
&gt;&gt;&gt; u'André'
u'Andr\xe9'
&gt;&gt;&gt; print u'André'
André
</pre>
<p>However, if you use Crunchy (with Python ... not Jython), this is what you will see instead:</p>
<pre title="pycon">
&gt;&gt;&gt; print 'André'
André
&gt;&gt;&gt; 'André'
'Andr\xc3\xa9'
&gt;&gt;&gt; u'André'   # This is different
u'Andr\xc3\xa9'
&gt;&gt;&gt; print u'André'   # and so is this
   Crunchy Error in trying to decode inside cometIO.py
   The likely cause is trying to print a unicode string prefixed by u
   as in u"...". If not, please file a bug report.
AndrÃ©
</pre>
<p>If you use Jython with unicode strings, it seems that no matter what you try,
a traceback results.</p>
<p>When you are writing code from within Crunchy (not to be saved in a file),
and using Python 2.x, just drop the u prefix for unicode strings and
everything will work just as though you had included it while coding
in other environments.
</p>

<h3>New to Crunchy?</h3>
<p>If you are new to Crunchy, or have used an older version,
we strongly suggest that you first
go through the basic tutorial using the links on the left.</p>

<p>You can use the Crunchy Menu at the top right to come back to this page or
if you have administrator privileges, to quit Crunchy altogether.</p>
<p>Note that, whenever you see this image:
<img title="cluetip Except for this one!" rel="/docs/popups/monty1.html"
src="/images/help.png" style="height:32px;"/>,
it is because the Crunchy developers (or perhaps some other tutorial writer) have written
some useful tip that you can view by clicking on them.  Note that if you click
on them a second time, the useful tip will disappear. If you don't want these
images, and the information they refer to, to appear at all,
use the selector below to turn them off (except for this page!)</p>
<div title="preferences popups">irrelevant text</div>
<p>
Other images, such as <img title="cluetip No information this time. | Please try again later."
src="/images/stop.png" style="height:32px;"/> may also be used in this fashion - however,
these can not be turned off.
</p>

<p>
Other user preferences can be selected
    <a href="/docs/basic_tutorial/preferences.html">via this link</a>, or via the
"Preferences" Crunchy menu item at the top-right corner.
</p>
</div>
</div>

</body>
</html>
